/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import {
  type VibrateAttribute,
  type VibrateEffect,
  VibratorStopMode,
} from './VibratorType';

export namespace VibratorModuleSpec {
  export const NAME = 'VibratorModule' as const;

  export interface Spec {
    // 查询是否支持传入参数effectId。
    isSupportEffect(effectId: string): Promise<boolean>;

    // 根据指定的振动效果和振动属性触发马达振动。
    startVibration(
      effect: VibrateEffect,
      attribute: VibrateAttribute,
    ): Promise<void>;

    // 停止马达振动, 如果设置了参数，按照指定模式停止马达振动。
    stopVibration(stopMode?: VibratorStopMode): Promise<void>;

    // 停止任何形式的马达振动。
    stopVibrationSync(): void;
  }
}
